home *** CD-ROM | disk | FTP | other *** search
/ Sprite 1984 - 1993 / Sprite 1984 - 1993.iso / man / lib / tcl / CrtTrace.man < prev    next >
Encoding:
Text File  |  1992-08-07  |  8.1 KB  |  290 lines
  1. '\"
  2. '\" Copyright 1989 Regents of the University of California
  3. '\" Permission to use, copy, modify, and distribute this
  4. '\" documentation for any purpose and without fee is hereby
  5. '\" granted, provided that this notice appears in all copies.
  6. '\" The University of California makes no representations about
  7. '\" the suitability of this material for any purpose.  It is
  8. '\" provided "as is" without express or implied warranty.
  9. '\" 
  10. '\" $Header: /user6/ouster/tcl/man/RCS/CrtTrace.man,v 1.5 91/12/06 10:34:44 ouster Exp $ SPRITE (Berkeley)
  11. '\" 
  12. .\" The definitions below are for supplemental macros used in Sprite
  13. .\" manual entries.
  14. .\"
  15. .\" .HS name section [date [version]]
  16. .\"    Replacement for .TH in other man pages.  See below for valid
  17. .\"    section names.
  18. .\"
  19. .\" .AP type name in/out [indent]
  20. .\"    Start paragraph describing an argument to a library procedure.
  21. .\"    type is type of argument (int, etc.), in/out is either "in", "out",
  22. .\"    or "in/out" to describe whether procedure reads or modifies arg,
  23. .\"    and indent is equivalent to second arg of .IP (shouldn't ever be
  24. .\"    needed;  use .AS below instead)
  25. .\"
  26. .\" .AS [type [name]]
  27. .\"    Give maximum sizes of arguments for setting tab stops.  Type and
  28. .\"    name are examples of largest possible arguments that will be passed
  29. .\"    to .AP later.  If args are omitted, default tab stops are used.
  30. .\"
  31. .\" .BS
  32. .\"    Start box enclosure.  From here until next .BE, everything will be
  33. .\"    enclosed in one large box.
  34. .\"
  35. .\" .BE
  36. .\"    End of box enclosure.
  37. .\"
  38. .\" .VS
  39. .\"    Begin vertical sidebar, for use in marking newly-changed parts
  40. .\"    of man pages.
  41. .\"
  42. .\" .VE
  43. .\"    End of vertical sidebar.
  44. .\"
  45. .\" .DS
  46. .\"    Begin an indented unfilled display.
  47. .\"
  48. .\" .DE
  49. .\"    End of indented unfilled display.
  50. .\"
  51. '\"    # Heading for Sprite man pages
  52. .de HS
  53. .if '\\$2'cmds'       .TH \\$1 1 \\$3 \\$4
  54. .if '\\$2'lib'        .TH \\$1 3 \\$3 \\$4
  55. .if '\\$2'tcl'        .TH \\$1 3 \\$3 \\$4
  56. .if '\\$2'tk'         .TH \\$1 3 \\$3 \\$4
  57. .if t .wh -1.3i ^B
  58. .nr ^l \\n(.l
  59. .ad b
  60. ..
  61. '\"    # Start an argument description
  62. .de AP
  63. .ie !"\\$4"" .TP \\$4
  64. .el \{\
  65. .   ie !"\\$2"" .TP \\n()Cu
  66. .   el          .TP 15
  67. .\}
  68. .ie !"\\$3"" \{\
  69. .ta \\n()Au \\n()Bu
  70. \&\\$1    \\fI\\$2\\fP    (\\$3)
  71. .\".b
  72. .\}
  73. .el \{\
  74. .br
  75. .ie !"\\$2"" \{\
  76. \&\\$1    \\fI\\$2\\fP
  77. .\}
  78. .el \{\
  79. \&\\fI\\$1\\fP
  80. .\}
  81. .\}
  82. ..
  83. '\"    # define tabbing values for .AP
  84. .de AS
  85. .nr )A 10n
  86. .if !"\\$1"" .nr )A \\w'\\$1'u+3n
  87. .nr )B \\n()Au+15n
  88. .\"
  89. .if !"\\$2"" .nr )B \\w'\\$2'u+\\n()Au+3n
  90. .nr )C \\n()Bu+\\w'(in/out)'u+2n
  91. ..
  92. '\"    # BS - start boxed text
  93. '\"    # ^y = starting y location
  94. '\"    # ^b = 1
  95. .de BS
  96. .br
  97. .mk ^y
  98. .nr ^b 1u
  99. .if n .nf
  100. .if n .ti 0
  101. .if n \l'\\n(.lu\(ul'
  102. .if n .fi
  103. ..
  104. '\"    # BE - end boxed text (draw box now)
  105. .de BE
  106. .nf
  107. .ti 0
  108. .mk ^t
  109. .ie n \l'\\n(^lu\(ul'
  110. .el \{\
  111. .\"    Draw four-sided box normally, but don't draw top of
  112. .\"    box if the box started on an earlier page.
  113. .ie !\\n(^b-1 \{\
  114. \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
  115. .\}
  116. .el \}\
  117. \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
  118. .\}
  119. .\}
  120. .fi
  121. .br
  122. .nr ^b 0
  123. ..
  124. '\"    # VS - start vertical sidebar
  125. '\"    # ^Y = starting y location
  126. '\"    # ^v = 1 (for troff;  for nroff this doesn't matter)
  127. .de VS
  128. .mk ^Y
  129. .ie n 'mc \s12\(br\s0
  130. .el .nr ^v 1u
  131. ..
  132. '\"    # VE - end of vertical sidebar
  133. .de VE
  134. .ie n 'mc
  135. .el \{\
  136. .ev 2
  137. .nf
  138. .ti 0
  139. .mk ^t
  140. \h'|\\n(^lu+3n'\L'|\\n(^Yu-1v\(bv'\v'\\n(^tu+1v-\\n(^Yu'\h'-|\\n(^lu+3n'
  141. .sp -1
  142. .fi
  143. .ev
  144. .\}
  145. .nr ^v 0
  146. ..
  147. '\"    # Special macro to handle page bottom:  finish off current
  148. '\"    # box/sidebar if in box/sidebar mode, then invoked standard
  149. '\"    # page bottom macro.
  150. .de ^B
  151. .ev 2
  152. 'ti 0
  153. 'nf
  154. .mk ^t
  155. .if \\n(^b \{\
  156. .\"    Draw three-sided box if this is the box's first page,
  157. .\"    draw two sides but no top otherwise.
  158. .ie !\\n(^b-1 \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c
  159. .el \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c
  160. .\}
  161. .if \\n(^v \{\
  162. .nr ^x \\n(^tu+1v-\\n(^Yu
  163. \kx\h'-\\nxu'\h'|\\n(^lu+3n'\ky\L'-\\n(^xu'\v'\\n(^xu'\h'|0u'\c
  164. .\}
  165. .bp
  166. 'fi
  167. .ev
  168. .if \\n(^b \{\
  169. .mk ^y
  170. .nr ^b 2
  171. .\}
  172. .if \\n(^v \{\
  173. .mk ^Y
  174. .\}
  175. ..
  176. '\"    # DS - begin display
  177. .de DS
  178. .RS
  179. .nf
  180. .sp
  181. ..
  182. '\"    # DE - end display
  183. .de DE
  184. .fi
  185. .RE
  186. .sp .5
  187. ..
  188. .HS Tcl_CreateTrace tcl
  189. .BS
  190. .SH NAME
  191. Tcl_CreateTrace, Tcl_DeleteTrace \- arrange for command execution to be traced
  192. .SH SYNOPSIS
  193. .nf
  194. \fB#include <tcl.h>\fR
  195. .sp
  196. Tcl_Trace
  197. \fBTcl_CreateTrace\fR(\fIinterp, level, proc, clientData\fR)
  198. .sp
  199. \fBTcl_DeleteTrace\fR(\fIinterp, trace\fR)
  200. .SH ARGUMENTS
  201. .AS Tcl_CmdTraceProc (clientData)()
  202. .AP Tcl_Interp *interp in
  203. Interpreter containing command to be traced or untraced.
  204. .AP int level in
  205. Only commands at or below this nesting level will be traced.  1 means
  206. top-level commands only, 2 means top-level commands or those that are
  207. invoked as immediate consequences of executing top-level commands
  208. (procedure bodies, bracketed commands, etc.) and so on.
  209. .AP Tcl_CmdTraceProc *proc in
  210. Procedure to call for each command that's executed.  See below for
  211. details on the calling sequence.
  212. .AP ClientData clientData in
  213. Arbitrary one-word value to pass to \fIproc\fR.
  214. .AP Tcl_Trace trace in
  215. Token for trace to be removed (return value from previous call
  216. to \fBTcl_CreateTrace\fR).
  217. .BE
  218.  
  219. .SH DESCRIPTION
  220. .PP
  221. \fBTcl_CreateTrace\fR arranges for command tracing.  From now on, \fIproc\fR
  222. will be invoked before Tcl calls command procedures to process
  223. commands in \fIinterp\fR.  The return value from
  224. \fBTcl_CreateTrace\fR is a token for the trace,
  225. which may be passed to \fBTcl_DeleteTrace\fR to remove the trace.  There may
  226. be many traces in effect simultaneously for the same command interpreter.
  227. .PP
  228. \fIProc\fR should have arguments and result that match the
  229. type \fBTcl_CmdTraceProc\fR:
  230. .nf
  231. .sp
  232. .RS
  233. typedef void Tcl_CmdTraceProc(
  234. .RS
  235. ClientData \fIclientData\fR,
  236. Tcl_Interp *\fIinterp\fR,
  237. int \fIlevel\fR,
  238. char *\fIcommand\fR,
  239. Tcl_CmdProc *\fIcmdProc\fR,
  240. ClientData \fIcmdClientData\fR,
  241. int \fIargc\fR,
  242. char *\fIargv\fR[]));
  243. .sp
  244. .RE
  245. .RE
  246. .fi
  247. The \fIclientData\fP and \fIinterp\fP parameters are
  248. copies of the corresponding arguments given to \fBTcl_CreateTrace\fR.
  249. \fIClientData\fR typically points to an application-specific
  250. data structure that describes what to do when \fIproc\fR
  251. is invoked.  \fILevel\fR gives the nesting level of the command
  252. (1 for top-level commands passed to \fBTcl_Eval\fR by the application,
  253. 2 for the next-level commands passed to \fBTcl_Eval\fR as part of parsing
  254. or interpreting level-1 commands, and so on).  \fICommand\fR
  255. points to a string containing the text of the
  256. command, before any argument substitution.
  257. \fICmdProc\fR contains the address of the command procedure that
  258. will be called to process the command (i.e. the \fIproc\fR argument
  259. of some previous call to \fBTcl_CreateCommand\fR) and \fIcmdClientData\fR
  260. contains the associated client data for \fIcmdProc\fR (the \fIclientData\fR
  261. value passed to \fBTcl_CreateCommand\fR).  \fIArgc\fR and \fIargv\fR give
  262. the final argument information that will be passed to \fIcmdProc\fR, after
  263. command, variable, and backslash substitution.
  264. \fIProc\fR must not modify the \fIcommand\fR or \fIargv\fR strings.
  265. .PP
  266. Tracing will only occur for commands at nesting level less than
  267. or equal to the \fIlevel\fR parameter (i.e. the \fIlevel\fR
  268. parameter to \fIproc\fR will always be less than or equal to the
  269. \fIlevel\fR parameter to \fBTcl_CreateTrace\fR).
  270. .PP
  271. Calls to \fIproc\fR will be made by the Tcl parser immediately before
  272. it calls the command procedure for the command (\fIcmdProc\fR).  This
  273. occurs after argument parsing and substitution, so tracing for
  274. substituted commands occurs before tracing of the commands
  275. containing the substitutions.  If there is a syntax error in a
  276. command, or if there is no command procedure associated with a
  277. command name, then no tracing will occur for that command.  If a
  278. string passed to Tcl_Eval contains multiple commands (bracketed, or
  279. on different lines) then multiple calls to \fIproc\fR will occur,
  280. one for each command.  The \fIcommand\fR string for each of these
  281. trace calls will reflect only a single command, not the entire string
  282. passed to Tcl_Eval.
  283. .PP
  284. \fBTcl_DeleteTrace\fR removes a trace, so that no future calls will be
  285. made to the procedure associated with the trace.  After \fBTcl_DeleteTrace\fR
  286. returns, the caller should never again use the \fItrace\fR token.
  287.  
  288. .SH KEYWORDS
  289. command, create, delete, interpreter, trace
  290.